| Class: LSAPostalAddresseS |
Manages the postal addresses and the correspondence information of an contact or organization
unit.
- Version:
-
1.2.6, 04.AUG.2000
- History:
| 04.AUG.2000 | RGR | recalcCorrespondence doesn't handle empty opening, closing and label types
|
| 03.AUG.2000 | RGR | saveToPredefinedFields has to be adopted to changes in getDefaultItem
|
| 02.AUG.2000 | RGR | setDefaultItem and getDefaultItem changed
|
| 27.JUL.2000 | RGR | property GetDefaultPostalAddress changed
|
| 08.JUN.2000 | RGR | Delete method modified to delete child objects
|
| 31.MAY.2000 | RGR | properties label,closing. and opening changed to use new functionality
|
| 31.MAY.2000 | RGR | methods setAutoRefreshed and recalcCorrespondence added
|
Public Property Set AddrDataID AsString
Sets the Instance ID of the LSAAddressData object. If this ID isn't available then
the properties Label, Opening and Closing cannot be computed correctly because
the property DefaultData of the class isn't available. The ID is set by the object
LSAAddressData when this object is accessed via the Property "PostalAddresses"
of the class LSAAddressData.
Public Property Get AddrDataID AsString
Public Property Get AddrDataInstance AsVariant
If the property AddressDataID is set to an correct Instance ID of the
LSAAddressData object which can be obtained by the instance manager
class this property returns a handle to object.
Public Property Get DefaultPostalAddress AsString
Returns the formatted information about the default postal address of the
contact or organizational unit.Unlike the other lists the default postal address
could be an address not maintained in this list! The string is empty if the
default item doesn't exit.
- History:
| 27.JUL.2000 | RGR | if default item is nothing then empty string is returned
|
Public Property Get PostalAddressList AsVariant
Returns an array of serial data strings. Each entry corresponds to a postal address
in the NamedList class and can be used to explode the list.
Public Property Get PostalAddressKeyS AsVariant
Returns an array of string with the keysof the postal addresses maintained in the list
Public Property Get PostalAddresseS AsVariant
This property returns an array of string with the
the formatted postal addresses (view index) maintained in the list
Public Property Get PostalAddressDefaultS AsVariant
Returns an array of strings. On the position of the DefaultItem of the list the value is "x"
Public Property Get Count AsInteger
Returns the number of elements in the list.
Public Property Set LabelType AsString
Sets the name of the label type which is used to format
the label of the default postal address in the correspondence module
Public Property Get LabelType AsString
Public Property Set ClosingType AsString
Sets the name of the closing type which is used to format the close of the
default postal address in the correspondence module
Public Property Get ClosingType AsString
Public Property Set OpeningType AsString
Returns the name of the opening type which is
used to format the opening of the default postal address in the correspondence module
Public Property Get OpeningType AsString
Public Property Set FormatOrg AsString
Public Property Get FormatOrg AsString
Public Property Set AutoUpdate AsInteger
This property is used to switch on and off the automatic update
of the label formatting in the correspondence module
Public Property Get AutoUpdate AsInteger
Public Property Set Label AsString
The formatted default address of a contact or organization unit
Public Property Get Label AsString
- History:
| 31.MAY.2000 | RGR | changed to use recalcCorrespondence
|
Public Property Set Opening AsString
Set the opening which should used for the contact or organization in a letter.
Public Property Get Opening AsString
- History:
| 31.MAY.2000 | RGR | changed to use recalcCorrespondence
|
Public Property Set Closing AsString
Set the Closing which should used for the contact or organization in a letter.
Public Property Get Closing AsString
- History:
| 31.MAY.2000 | RGR | changed to use recalcCorrespondence
|
Public Property Set ListDelimiter AsString
When the object is imploded to a serial data string this character will be used as seperator.
If the programmer doesn't set a delimiter a default value will be delivered by the class.
Public Property Get ListDelimiter AsString
Public Property Set ItemDelimiter AsString
When the an item is imploded to a serial data string this character will be used as seperator.
If the programmer doesn't set a delimiter a default value will be delivered by the class.
Public Property Get ItemDelimiter AsString
Public Property Set NotAllowedChars AsVariant
These characters are not allowed to be use in the items
Public Property Get NotAllowedChars AsVariant
New
Public Sub New(addrDataID As String)
Initialzes the internal NamedLists.
Delete
Public Sub Delete
Default destructor of the class. Deletes all child objects.
- History:
| 08.JUN.2000 | RGR | Child objects are deleted.
|
AddItem
Public Sub AddItem(newItem As LSAPostalAddress)
Adds a new postal address to the list
- Parameters:
| newItem | LSAPostalAddress | the new postal address object which should be added to the list
|
ClearCurrentItem
Public Sub ClearCurrentItem
Deletes the current item from the list
ClearAllItems
Public Sub ClearAllItems
Reinitializes the postal address list
UpdateCurrentItem
Public Sub UpdateCurrentItem(UpdateItem As LSAPostalAddress)
Updates the current item with the data from the UpdateItem
- Parameters:
| updateItem | LSAPostalAddress | item storing the update information
|
IsDefault
Public Function IsDefault(CompareItem As LSAPostalAddress) As Integer
Checks if the parameter item is the default item of the list.
- Parameters:
| compareItem | LSAPostalAddress | the item the object is compared with
|
- Returns:
| Boolean | true, if the item is the default item
|
SetCurrentItem
Public Sub SetCurrentItem(newCurrentItem As LSAPostalAddress)
Set the current item to the parameter item
- Parameters:
| newCurrentItem | LSAPostalAddress | the item which should be used as current item
|
- History:
| 04.AUG.2000 | RGR | nothing as currentItem was handled correctly
|
SetDefaultItem
Public Sub SetDefaultItem(newDefaultItem As LSAPostalAddress)
Set the default item to the parameter item
GetItemByKey
Public Function GetItemByKey(ItemKey As String,MoveCurrentItem As Integer) As LSAPostalAddress
GetDefaultItem
Public Function GetDefaultItem As LSAPostalAddress
Returns the default item of the list. If the item hasn't been set with the function
setDefaultItem "Nothing" is returned.
- Returns:
| LSAPostalAddress | the default item
|
- History:
| 02.AUG.2000 | RGR | nothing is returned if the function setDeafultItem hasn't be used
|
| 02.AUG.2000 | RGR | check if the default item is in the list and refresh acccordingly
|
GetCurrentItem
Public Function GetCurrentItem As LSAPostalAddress
Returns the current item of the list
- Returns:
| LSAPostalAddress | item which the current pointer is pointing at
|
GetFirstItem
Public Function GetFirstItem As LSAPostalAddress
Returns the first item of the list
- Returns:
| LSAPhoneItem | the first item in the list
|
GetNextItem
Public Function GetNextItem As LSAPostalAddress
Returns the item next to the current item of the list.
- Returns:
| LSAPhoneItem | next item to the current item
|
GetPreviousItem
Public Function GetPreviousItem As LSAPostalAddress
getInternalCorrespondenceData
Public Function getInternalCorrespondenceData As Variant
Returns the internal not freshly calculated values Label, Opening and Closing.
SaveToPredefinedFields
Public Function SaveToPredefinedFields(doc As NotesDocument) As Integer
This function stores the properties of the class to some predefined fields as defined
by the plug&play design elements of LSA-Address. If the parameter save default is true
the information of the default postal address is stored in the document, otherwise the
person or organizational unit uses postal address from another person or organizational
unit as default. The parameter doc identifies the (main) document where the data is
stored.
- Parameters:
| doc | NotesDocument | The document which correspond to the unit.
|
- Returns:
| Integer | True, if an item in the document has been changed, false else
|
- History:
| 03.AUG.2000 | RGR | GetDefaultItem = Nothing wasn't handled correctly
|
Explode
Public Sub Explode(SerialDataArr As Variant)
Fills the list with the serialized object provided by the parameter array
fillFromDocS
Public Function fillFromDocS(parentdoc As NotesDocument) As Integer
This method is specific for the need of LSAAddr and LSAOrga.
Therefore will use fieldnames and internal knowledge of class
SaveToResponses
Public Sub SaveToResponses(parentdoc As NotesDocument)
This method saves the postal address list to response documents
isCorrespondenceCalculated
Public Function isCorrespondenceCalculated As Integer
Indicates if the correspondence data (label, opening and closing) is currently calculated. Because
this switch is used by the class LSAAddressData the function has to be public. In
Java this would be a protected function. This function should not be used by external functions !!!
- See also:
setCorrespondenceCalculated
Public Sub setCorrespondenceCalculated(newValue As Integer)
- See also:
isAutoRefreshed
Public Function isAutoRefreshed As Integer
Indicates if the correspondence data (label, opening and closing) is calculated everytime one of the properties
label, opening or closing is called or if the function recalcCorrespondence must be triggered manually. Because
This function should be used by external functions!
- See also:
setAutoRefreshed
Public Sub setAutoRefreshed(newValue As Integer)
- See also:
recalcCorrespondence
Public Sub recalcCorrespondence
Does the calculation of the three properties label, opening and closing.
Don't use this function, use the properties instead.
- History:
| 04.AUG.2000 | RGR | recalcCorrespondence doesn't handle empty opening, closing and label types
|
getAddressData
Public Function getAddressData As String
Calcualtes the LotusA datablock which is inserted into DefaultData
- Returns:
| a | string of the form ##LotusA############
|
| Top | LotusScript Doc |
| © Lotus Professional Services |
| generated on : 05-Apr-01 8:45:34 AM |